home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / lisp / gnus / nnspool.el.z / nnspool.el
Encoding:
Text File  |  1998-05-21  |  15.7 KB  |  478 lines
  1. ;;; nnspool.el --- spool access for GNU Emacs
  2. ;; Copyright (C) 1988,89,90,93,94,95,96,97 Free Software Foundation, Inc.
  3.  
  4. ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
  5. ;;     Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
  6. ;; Keywords: news
  7.  
  8. ;; This file is part of GNU Emacs.
  9.  
  10. ;; GNU Emacs is free software; you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation; either version 2, or (at your option)
  13. ;; any later version.
  14.  
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. ;; GNU General Public License for more details.
  19.  
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23. ;; Boston, MA 02111-1307, USA.
  24.  
  25. ;;; Commentary:
  26.  
  27. ;;; Code:
  28.  
  29. (require 'nnheader)
  30. (require 'nntp)
  31. (require 'timezone)
  32. (require 'nnoo)
  33. (eval-when-compile (require 'cl))
  34.  
  35. (nnoo-declare nnspool)
  36.  
  37. (defvoo nnspool-inews-program news-inews-program
  38.   "Program to post news.
  39. This is most commonly `inews' or `injnews'.")
  40.  
  41. (defvoo nnspool-inews-switches '("-h" "-S")
  42.   "Switches for nnspool-request-post to pass to `inews' for posting news.
  43. If you are using Cnews, you probably should set this variable to nil.")
  44.  
  45. (defvoo nnspool-spool-directory (file-name-as-directory news-path)
  46.   "Local news spool directory.")
  47.  
  48. (defvoo nnspool-nov-directory (concat nnspool-spool-directory "over.view/")
  49.   "Local news nov directory.")
  50.  
  51. (defvoo nnspool-lib-dir "/usr/lib/news/"
  52.   "Where the local news library files are stored.")
  53.  
  54. (defvoo nnspool-active-file (concat nnspool-lib-dir "active")
  55.   "Local news active file.")
  56.  
  57. (defvoo nnspool-newsgroups-file (concat nnspool-lib-dir "newsgroups")
  58.   "Local news newsgroups file.")
  59.  
  60. (defvoo nnspool-distributions-file (concat nnspool-lib-dir "distribs.pat")
  61.   "Local news distributions file.")
  62.  
  63. (defvoo nnspool-history-file (concat nnspool-lib-dir "history")
  64.   "Local news history file.")
  65.  
  66. (defvoo nnspool-active-times-file (concat nnspool-lib-dir "active.times")
  67.   "Local news active date file.")
  68.  
  69. (defvoo nnspool-large-newsgroup 50
  70.   "The number of the articles which indicates a large newsgroup.
  71. If the number of the articles is greater than the value, verbose
  72. messages will be shown to indicate the current status.")
  73.  
  74. (defvoo nnspool-nov-is-evil nil
  75.   "Non-nil means that nnspool will never return NOV lines instead of headers.")
  76.  
  77. (defconst nnspool-sift-nov-with-sed nil
  78.   "If non-nil, use sed to get the relevant portion from the overview file.
  79. If nil, nnspool will load the entire file into a buffer and process it
  80. there.")
  81.  
  82. (defvoo nnspool-rejected-article-hook nil
  83.   "*A hook that will be run when an article has been rejected by the server.")
  84.  
  85. ;; 1997/8/14 by MORIOKA Tomohiko
  86. (defvoo nnspool-file-coding-system nnheader-file-coding-system
  87.   "Coding system for nnspool.")
  88.  
  89.  
  90.  
  91. (defconst nnspool-version "nnspool 2.0"
  92.   "Version numbers of this version of NNSPOOL.")
  93.  
  94. (defvoo nnspool-current-directory nil
  95.   "Current news group directory.")
  96.  
  97. (defvoo nnspool-current-group nil)
  98. (defvoo nnspool-status-string "")
  99.  
  100.  
  101. ;;; Interface functions.
  102.  
  103. (nnoo-define-basics nnspool)
  104.  
  105. (deffoo nnspool-retrieve-headers (articles &optional group server fetch-old)
  106.   "Retrieve the headers of ARTICLES."
  107.   (save-excursion
  108.     (set-buffer nntp-server-buffer)
  109.     (erase-buffer)
  110.     (when (nnspool-possibly-change-directory group)
  111.       (let* ((number (length articles))
  112.          (count 0)
  113.          (default-directory nnspool-current-directory)
  114.          (do-message (and (numberp nnspool-large-newsgroup)
  115.                   (> number nnspool-large-newsgroup)))
  116.          ;; 1997/8/14 by MORIOKA Tomohiko
  117.          ;;   for Win32
  118.          (nnheader-file-coding-system nnspool-file-coding-system)
  119.          file beg article ag)
  120.     (if (and (numberp (car articles))
  121.          (nnspool-retrieve-headers-with-nov articles fetch-old))
  122.         ;; We successfully retrieved the NOV headers.
  123.         'nov
  124.       ;; No NOV headers here, so we do it the hard way.
  125.       (while (setq article (pop articles))
  126.         (if (stringp article)
  127.         ;; This is a Message-ID.
  128.         (setq ag (nnspool-find-id article)
  129.               file (and ag (nnspool-article-pathname
  130.                     (car ag) (cdr ag)))
  131.               article (cdr ag))
  132.           ;; This is an article in the current group.
  133.           (setq file (int-to-string article)))
  134.         ;; Insert the head of the article.
  135.         (when (and file
  136.                (file-exists-p file))
  137.           (insert "221 ")
  138.           (princ article (current-buffer))
  139.           (insert " Article retrieved.\n")
  140.           (setq beg (point))
  141.           (inline (nnheader-insert-head file))
  142.           (goto-char beg)
  143.           (search-forward "\n\n" nil t)
  144.           (forward-char -1)
  145.           (insert ".\n")
  146.           (delete-region (point) (point-max)))
  147.  
  148.         (and do-message
  149.          (zerop (% (incf count) 20))
  150.          (message "nnspool: Receiving headers... %d%%"
  151.               (/ (* count 100) number))))
  152.  
  153.       (when do-message
  154.         (message "nnspool: Receiving headers...done"))
  155.  
  156.       ;; Fold continuation lines.
  157.       (nnheader-fold-continuation-lines)
  158.       'headers)))))
  159.  
  160. (deffoo nnspool-open-server (server &optional defs)
  161.   (nnoo-change-server 'nnspool server defs)
  162.   (cond
  163.    ((not (file-exists-p nnspool-spool-directory))
  164.     (nnspool-close-server)
  165.     (nnheader-report 'nnspool "Spool directory doesn't exist: %s"
  166.              nnspool-spool-directory))
  167.    ((not (file-directory-p
  168.       (directory-file-name
  169.        (file-truename nnspool-spool-directory))))
  170.     (nnspool-close-server)
  171.     (nnheader-report 'nnspool "Not a directory: %s" nnspool-spool-directory))
  172.    ((not (file-exists-p nnspool-active-file))
  173.     (nnheader-report 'nnspool "The active file doesn't exist: %s"
  174.              nnspool-active-file))
  175.    (t
  176.     (nnheader-report 'nnspool "Opened server %s using directory %s"
  177.              server nnspool-spool-directory)
  178.     t)))
  179.  
  180. (deffoo nnspool-request-article (id &optional group server buffer)
  181.   "Select article by message ID (or number)."
  182.   (nnspool-possibly-change-directory group)
  183.   (let ((nntp-server-buffer (or buffer nntp-server-buffer))
  184.     file ag)
  185.     (if (stringp id)
  186.     ;; This is a Message-ID.
  187.     (when (setq ag (nnspool-find-id id))
  188.       (setq file (nnspool-article-pathname (car ag) (cdr ag))))
  189.       (setq file (nnspool-article-pathname nnspool-current-group id)))
  190.     (and file
  191.      (file-exists-p file)
  192.      (not (file-directory-p file))
  193.      (save-excursion (nnspool-find-file file))
  194.      ;; We return the article number and group name.
  195.      (if (numberp id)
  196.          (cons nnspool-current-group id)
  197.        ag))))
  198.  
  199. (deffoo nnspool-request-body (id &optional group server)
  200.   "Select article body by message ID (or number)."
  201.   (nnspool-possibly-change-directory group)
  202.   (let ((res (nnspool-request-article id)))
  203.     (when res
  204.       (save-excursion
  205.     (set-buffer nntp-server-buffer)
  206.     (goto-char (point-min))
  207.     (when (search-forward "\n\n" nil t)
  208.       (delete-region (point-min) (point)))
  209.     res))))
  210.  
  211. (deffoo nnspool-request-head (id &optional group server)
  212.   "Select article head by message ID (or number)."
  213.   (nnspool-possibly-change-directory group)
  214.   (let ((res (nnspool-request-article id)))
  215.     (when res
  216.       (save-excursion
  217.     (set-buffer nntp-server-buffer)
  218.     (goto-char (point-min))
  219.     (when (search-forward "\n\n" nil t)
  220.       (delete-region (1- (point)) (point-max)))
  221.     (nnheader-fold-continuation-lines)))
  222.     res))
  223.  
  224. (deffoo nnspool-request-group (group &optional server dont-check)
  225.   "Select news GROUP."
  226.   (let ((pathname (nnspool-article-pathname group))
  227.     dir)
  228.     (if (not (file-directory-p pathname))
  229.     (nnheader-report
  230.      'nnspool "Invalid group name (no such directory): %s" group)
  231.       (setq nnspool-current-directory pathname)
  232.       (nnheader-report 'nnspool "Selected group %s" group)
  233.       (if dont-check
  234.       (progn
  235.         (nnheader-report 'nnspool "Selected group %s" group)
  236.         t)
  237.     ;; Yes, completely empty spool directories *are* possible.
  238.     ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
  239.     (when (setq dir (directory-files pathname nil "^[0-9]+$" t))
  240.       (setq dir
  241.         (sort (mapcar (lambda (name) (string-to-int name)) dir) '<)))
  242.     (if dir
  243.         (nnheader-insert
  244.          "211 %d %d %d %s\n" (length dir) (car dir)
  245.          (progn (while (cdr dir) (setq dir (cdr dir))) (car dir))
  246.          group)
  247.       (nnheader-report 'nnspool "Empty group %s" group)
  248.       (nnheader-insert "211 0 0 0 %s\n" group))))))
  249.  
  250. (deffoo nnspool-request-type (group &optional article)
  251.   'news)
  252.  
  253. (deffoo nnspool-close-group (group &optional server)
  254.   t)
  255.  
  256. (deffoo nnspool-request-list (&optional server)
  257.   "List active newsgroups."
  258.   (save-excursion
  259.     (or (nnspool-find-file nnspool-active-file)
  260.     (nnheader-report 'nnspool (nnheader-file-error nnspool-active-file)))))
  261.  
  262. (deffoo nnspool-request-list-newsgroups (&optional server)
  263.   "List newsgroups (defined in NNTP2)."
  264.   (save-excursion
  265.     (or (nnspool-find-file nnspool-newsgroups-file)
  266.     (nnheader-report 'nnspool (nnheader-file-error
  267.                    nnspool-newsgroups-file)))))
  268.  
  269. (deffoo nnspool-request-list-distributions (&optional server)
  270.   "List distributions (defined in NNTP2)."
  271.   (save-excursion
  272.     (or (nnspool-find-file nnspool-distributions-file)
  273.     (nnheader-report 'nnspool (nnheader-file-error
  274.                    nnspool-distributions-file)))))
  275.  
  276. ;; Suggested by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
  277. (deffoo nnspool-request-newgroups (date &optional server)
  278.   "List groups created after DATE."
  279.   (if (nnspool-find-file nnspool-active-times-file)
  280.       (save-excursion
  281.     ;; Find the last valid line.
  282.     (goto-char (point-max))
  283.     (while (and (not (looking-at
  284.               "\\([^ ]+\\) +\\([0-9]+\\)[0-9][0-9][0-9] "))
  285.             (zerop (forward-line -1))))
  286.     (let ((seconds (nnspool-seconds-since-epoch date))
  287.           groups)
  288.       ;; Go through lines and add the latest groups to a list.
  289.       (while (and (looking-at "\\([^ ]+\\) +[0-9]+ ")
  290.               (progn
  291.             ;; We insert a .0 to make the list reader
  292.             ;; interpret the number as a float.  It is far
  293.             ;; too big to be stored in a lisp integer.
  294.             (goto-char (1- (match-end 0)))
  295.             (insert ".0")
  296.             (> (progn
  297.                  (goto-char (match-end 1))
  298.                  (read (current-buffer)))
  299.                seconds))
  300.               (push (buffer-substring
  301.                       (match-beginning 1) (match-end 1))
  302.                      groups)
  303.               (zerop (forward-line -1))))
  304.       (erase-buffer)
  305.       (while groups
  306.         (insert (car groups) " 0 0 y\n")
  307.         (setq groups (cdr groups))))
  308.     t)
  309.     nil))
  310.  
  311. (deffoo nnspool-request-post (&optional server)
  312.   "Post a new news in current buffer."
  313.   (save-excursion
  314.     (let* ((process-connection-type nil) ; t bugs out on Solaris
  315.        (inews-buffer (generate-new-buffer " *nnspool post*"))
  316.        (proc
  317.         (condition-case err
  318.         (apply 'start-process "*nnspool inews*" inews-buffer
  319.                nnspool-inews-program nnspool-inews-switches)
  320.           (error
  321.            (nnheader-report 'nnspool "inews error: %S" err)))))
  322.       (if (not proc)
  323.       ;; The inews program failed.
  324.       ()
  325.     (nnheader-report 'nnspool "")
  326.     (set-process-sentinel proc 'nnspool-inews-sentinel)
  327.     (process-send-region proc (point-min) (point-max))
  328.     ;; We slap a condition-case around this, because the process may
  329.     ;; have exited already...
  330.     (ignore-errors
  331.       (process-send-eof proc))
  332.     t))))
  333.  
  334.  
  335.  
  336. ;;; Internal functions.
  337.  
  338. (defun nnspool-inews-sentinel (proc status)
  339.   (save-excursion
  340.     (set-buffer (process-buffer proc))
  341.     (goto-char (point-min))
  342.     (if (or (zerop (buffer-size))
  343.         (search-forward "spooled" nil t))
  344.     (kill-buffer (current-buffer))
  345.       ;; Make status message by folding lines.
  346.       (while (re-search-forward "[ \t\n]+" nil t)
  347.     (replace-match " " t t))
  348.       (nnheader-report 'nnspool "%s" (buffer-string))
  349.       (message "nnspool: %s" nnspool-status-string)
  350.       (ding)
  351.       (run-hooks 'nnspool-rejected-article-hook))))
  352.  
  353. (defun nnspool-retrieve-headers-with-nov (articles &optional fetch-old)
  354.   (if (or gnus-nov-is-evil nnspool-nov-is-evil)
  355.       nil
  356.     (let ((nov (nnheader-group-pathname
  357.         nnspool-current-group nnspool-nov-directory ".overview"))
  358.       (arts articles)
  359.       ;; 1997/8/14 by MORIOKA Tomohiko
  360.       ;;   for Win32
  361.             (nnheader-file-coding-system nnspool-file-coding-system)
  362.       last)
  363.       (if (not (file-exists-p nov))
  364.       ()
  365.     (save-excursion
  366.       (set-buffer nntp-server-buffer)
  367.       (erase-buffer)
  368.       (if nnspool-sift-nov-with-sed
  369.           (nnspool-sift-nov-with-sed articles nov)
  370.         (nnheader-insert-file-contents nov)
  371.         (if (and fetch-old
  372.              (not (numberp fetch-old)))
  373.         t            ; We want all the headers.
  374.           (ignore-errors
  375.         ;; Delete unwanted NOV lines.
  376.         (nnheader-nov-delete-outside-range
  377.          (if fetch-old (max 1 (- (car articles) fetch-old))
  378.            (car articles))
  379.          (car (last articles)))
  380.         ;; If the buffer is empty, this wasn't very successful.
  381.         (unless (zerop (buffer-size))
  382.           ;; We check what the last article number was.
  383.           ;; The NOV file may be out of sync with the articles
  384.           ;; in the group.
  385.           (forward-line -1)
  386.           (setq last (read (current-buffer)))
  387.           (if (= last (car articles))
  388.               ;; Yup, it's all there.
  389.               t
  390.             ;; Perhaps not.  We try to find the missing articles.
  391.             (while (and arts
  392.                 (<= last (car arts)))
  393.               (pop arts))
  394.             ;; The articles in `arts' are missing from the buffer.
  395.             (while arts
  396.               (nnspool-insert-nov-head (pop arts)))
  397.             t))))))))))
  398.  
  399. (defun nnspool-insert-nov-head (article)
  400.   "Read the head of ARTICLE, convert to NOV headers, and insert."
  401.   (save-excursion
  402.     (let ((cur (current-buffer))
  403.       buf)
  404.       (setq buf (nnheader-set-temp-buffer " *nnspool head*"))
  405.       (when (nnheader-insert-head
  406.          (nnspool-article-pathname nnspool-current-group article))
  407.     (nnheader-insert-article-line article)
  408.     (let ((headers (nnheader-parse-head)))
  409.       (set-buffer cur)
  410.       (goto-char (point-max))
  411.       (nnheader-insert-nov headers)))
  412.       (kill-buffer buf))))
  413.  
  414. (defun nnspool-sift-nov-with-sed (articles file)
  415.   (let ((first (car articles))
  416.     (last (progn (while (cdr articles) (setq articles (cdr articles)))
  417.              (car articles))))
  418.     (call-process "awk" nil t nil
  419.           (format "BEGIN {firstmsg=%d; lastmsg=%d;}\n $1 >= firstmsg && $1 <= lastmsg {print;}"
  420.               (1- first) (1+ last))
  421.           file)))
  422.  
  423. ;; Fixed by fdc@cliwe.ping.de (Frank D. Cringle).
  424. ;; Find out what group an article identified by a Message-ID is in.
  425. (defun nnspool-find-id (id)
  426.   (save-excursion
  427.     (set-buffer (get-buffer-create " *nnspool work*"))
  428.     (buffer-disable-undo (current-buffer))
  429.     (erase-buffer)
  430.     (ignore-errors
  431.       (call-process "grep" nil t nil (regexp-quote id) nnspool-history-file))
  432.     (goto-char (point-min))
  433.     (prog1
  434.     (when (looking-at "<[^>]+>[ \t]+[-0-9~]+[ \t]+\\([^ /\t\n]+\\)/\\([0-9]+\\)[ \t\n]")
  435.       (cons (match-string 1) (string-to-int (match-string 2))))
  436.       (kill-buffer (current-buffer)))))
  437.  
  438. (defun nnspool-find-file (file)
  439.   "Insert FILE in server buffer safely."
  440.   (set-buffer nntp-server-buffer)
  441.   (erase-buffer)
  442.   (condition-case ()
  443.       ;; 1997/8/14 by MORIOKA Tomohiko
  444.       ;;   for Win32
  445.       (let ((nnheader-file-coding-system nnspool-file-coding-system))
  446.     (nnheader-insert-file-contents file)
  447.     t)
  448.     (file-error nil)))
  449.  
  450. (defun nnspool-possibly-change-directory (group)
  451.   (if (not group)
  452.       t
  453.     (let ((pathname (nnspool-article-pathname group)))
  454.       (if (file-directory-p pathname)
  455.       (setq nnspool-current-directory pathname
  456.         nnspool-current-group group)
  457.     (nnheader-report 'nnspool "No such newsgroup: %s" group)))))
  458.  
  459. (defun nnspool-article-pathname (group &optional article)
  460.   "Find the path for GROUP."
  461.   (nnheader-group-pathname group nnspool-spool-directory article))
  462.  
  463. (defun nnspool-seconds-since-epoch (date)
  464.   (let* ((tdate (mapcar (lambda (ti) (and ti (string-to-int ti)))
  465.             (timezone-parse-date date)))
  466.      (ttime (mapcar (lambda (ti) (and ti (string-to-int ti)))
  467.             (timezone-parse-time
  468.              (aref (timezone-parse-date date) 3))))
  469.      (unix (encode-time (nth 2 ttime) (nth 1 ttime) (nth 0 ttime)
  470.                 (nth 2 tdate) (nth 1 tdate) (nth 0 tdate)
  471.                 (nth 4 tdate))))
  472.     (+ (* (car unix) 65536.0)
  473.        (cadr unix))))
  474.  
  475. (provide 'nnspool)
  476.  
  477. ;;; nnspool.el ends here
  478.